Matching Market

This simple model consists of a buyer, a supplier, and a market.

The buyer represents a group of customers whose willingness to pay for a single unit of the good is captured by a vector of prices wta. You can initiate the buyer with a set_quantity function which randomly assigns the willingness to pay according to your specifications. You may ask for these willingness to pay quantities with a getbid function.

The supplier is similiar, but instead the supplier is willing to be paid to sell a unit of technology. The supplier for instance may have non-zero variable costs that make them unwilling to produce the good unless they receive a specified price. Similarly the supplier has a get_ask function which returns a list of desired prices.

The willingness to pay or sell are set randomly using uniform random distributions. The resultant lists of bids are effectively a demand curve. Likewise the list of asks is effectively a supply curve. A more complex determination of bids and asks is possible, for instance using time of year to vary the quantities being demanded.

New in version 4

  • Fixed the initialization process of the buyers, sellers and markets. Thereby reducing the runtime from 24 hours to roughly 10 minutes.
  • Pulling the data for the runloop from an array instead of a dicitonary to preserve runtime order. A dictionary is unsorted and therefor the months were run in a seemingly random order.
  • Added visualization of the market price.
  • Fixed some future depreciated pandas code.

Microeconomic Foundations

The market assumes the presence of an auctioneer which will create a book, which seeks to match the bids and the asks as much as possible. If the auctioneer is neutral, then it is incentive compatible for the buyer and the supplier to truthfully announce their bids and asks. The auctioneer will find a single price which clears as much of the market as possible. Clearing the market means that as many willing swaps happens as possible. You may ask the market object at what price the market clears with the get_clearing_price function. You may also ask the market how many units were exchanged with the get_units_cleared function.

Agent-Based Objects

The following section presents three objects which can be used to make an agent-based model of an efficient, two-sided market.


In [8]:
%matplotlib inline
import matplotlib.pyplot as plt
import random as rnd
import pandas as pd
import numpy as np
import time
import datetime

In [9]:
# measure how long it takes to run the script
startit = time.time()
dtstartit = datetime.datetime.now()

class Seller():
    def __init__(self,name):
        self.name = name
        self.wta = []

    # the supplier has n quantities that they can sell
    # they may be willing to sell this quantity anywhere from a lower price of l
    # to a higher price of u
    def set_quantity(self,n,l,u):
        for i in range(n):
            p = rnd.uniform(l,u)
            self.wta.append(p)

    def get_name(self):
        return self.name
    
    def get_asks(self):
        return self.wta


class Buyer():
    
    def __init__(self, name):
        self.name = name
        self.wtp = []

    # the supplier has n quantities that they can buy
    # they may be willing to sell this quantity anywhere from a lower price of l
    # to a higher price of u
    def set_quantity(self, n, l, u):
        for i in range(n):
            p = rnd.uniform(l, u)
            self.wtp.append(p)
     
    def get_name(self):
        return self.name
    
    # return list of willingness to pay
    def get_bids(self):
        return self.wtp


class Book():
    def __init__(self):
        self.ledger = pd.DataFrame(columns = ("role","name","price","cleared"))

    
    def set_asks(self,seller_list):
        # ask each seller their name
        # ask each seller their willingness
        # for each willingness append the data frame
        for seller in seller_list:
            seller_name = seller.get_name()
            seller_price = seller.get_asks()
            for price in seller_price:
                self.ledger=self.ledger.append({"role":"seller","name":seller_name,"price":price,"cleared":"in process"},
                                               ignore_index=True)

    def set_bids(self,buyer_list):
        # ask each seller their name
        # ask each seller their willingness
        # for each willingness append the data frame
        for buyer in buyer_list:
            buyer_name = buyer.get_name()
            buyer_price = buyer.get_bids()
            for price in buyer_price:
                self.ledger=self.ledger.append({"role":"buyer","name":buyer_name,"price":price,"cleared":"in process"},
                                               ignore_index=True)

    def update_ledger(self,ledger):
        self.ledger = ledger
        
    def get_ledger(self):
        return self.ledger


class Market():
    def __init__(self):
        self.count = 0
        self.last_price = ''
        self.book = Book()
        self.b = []
        self.s = []
        self.ledger = ''

    def add_buyer(self,buyer):
        self.b.append(buyer)
        
    def add_seller(self,seller):
        self.s.append(seller)
    
    def set_book(self):
        self.book.set_bids(self.b)
        self.book.set_asks(self.s)
    
    def get_ledger(self):
        self.ledger = self.book.get_ledger()
        return self.ledger
    
    def get_bids(self):
        # this is a data frame
        ledger = self.book.get_ledger()
        rows= ledger.loc[ledger['role'] == 'buyer']
        # this is a series
        prices=rows['price']
        # this is a list
        bids = prices.tolist()
        return bids
    
    def get_asks(self):
        # this is a data frame
        ledger = self.book.get_ledger()
        rows = ledger.loc[ledger['role'] == 'seller']
        # this is a series
        prices=rows['price']
        # this is a list
        asks = prices.tolist()
        return asks
    
    # return the price at which the market clears
    # this fails because there are more buyers then sellers
    
    def get_clearing_price(self):
        # buyer makes a bid starting with the buyer which wants it most
        b = self.get_bids()
        s = self.get_asks()
        # highest to lowest
        self.b=sorted(b, reverse=True)
        # lowest to highest
        self.s=sorted(s, reverse=False)
        
        # find out whether there are more buyers or sellers
        # then drop the excess buyers or sellers; they won't compete
        n = len(b)
        m = len(s)
        
        # there are more sellers than buyers
        # drop off the highest priced sellers 
        if (m > n):
            s = s[0:n]
            matcher = n
        # There are more buyers than sellers
        # drop off the lowest bidding buyers 
        else:
            b = b[0:m]
            matcher = m
        
        # It's possible that not all items sold actually clear the market here
        for i in range(matcher):
            if (self.b[i] > self.s[i]):
                self.count +=1
                self.last_price = self.b[i]
                
        return self.last_price
    
    # TODO: Annotate the ledger
    def annotate_ledger(self,clearing_price):
        ledger = self.book.get_ledger()
        for index, row in ledger.iterrows():
            if (row['role'] == 'seller'):
                if (row['price'] < clearing_price):
                    ledger.loc[index,'cleared'] = 'True'
                else:
                    ledger.loc[index,'cleared'] = 'False'
            else:
                if (row['price'] > clearing_price):
                    ledger.loc[index,'cleared'] = 'True'
                else:
                    ledger.loc[index,'cleared'] = 'False'  
                    
        self.book.update_ledger(ledger)
    
    def get_units_cleared(self):
        return self.count

Example Market

In the following code example we use the buyer and supplier objects to create a market. At the market a single price is announced which causes as many units of goods to be swapped as possible. The buyers and sellers stop trading when it is no longer in their own interest to continue.


In [10]:
#record every run in a history book
hist_book = []

# is dictionary really suited? Sorted vs unsorted
# god_info is the the input for the model
# This is a example
'''
god_info = {
            'jan': {'home': (100, 0, 10), 'industry': (50, 0, 10), 'cat': (75, 0, 10)},
            'feb': {'home': (90, 0, 10), 'industry': (40, 0, 10), 'cat': (60, 0, 10)},
            'march': {'home': (100, 0, 10), 'industry': (50, 0, 10), 'cat': (75, 0, 10)}
            }
#'''

#read montly consumption data of 2010 into a dataframe
df = pd.read_csv('2010cbstestrun.csv', header=0, index_col=0)
df = df.transpose()

#make an array of for the buyers from the csv in the following format
#buyerinfo = [time ['home', (100, 0, 10)], ['industry', (50, 0, 10)], ['cat', (75, 0, 10)]]
god_info = [[x, [['elec',(y,0,10)],['indu',(z,0,10)],['home',(u,0,10)]]] 
            for x,y,z,u in zip(df.index,df['elec'],df['indu'],df['home'])]

for period in range(len(god_info)):
    print('#######################################')
    print(god_info[period][0])
    # time the period
    startit_period = time.time()
    
    # time initialising
    startit_init = time.time()
    

    # make a supplier and get the asks
    supplier = Seller("Natural Gas")
    supplier.set_quantity(2000,0,10)
    
    book = Book()
    #clear ledger
    #book.clear_ledger()
    book.set_asks([supplier])
    
    # make a buyer and get the bids in the following format:
    #buyerinfo = {'home': (100, 0, 10), 'industry': (50, 0, 10), 'cat': (75, 0, 10)}
    #buyerinfo = god_info[period]
    buyerinfo = dict([(k,v) for k,v in zip([god_info[period][1][i][0] for i in range(len(god_info[period][1]))],
                                           [god_info[period][1][i][1] for i in range(len(god_info[period][1]))])])
    buyer_dict = {}
    for name in buyerinfo:
        buyer_dict[name] = Buyer('%s' % name)
    
    for i in buyer_dict:
        buyer_dict[i].set_quantity(*buyerinfo[i])
    
    book.set_bids([buy for buy in buyer_dict.values()])
    ledger = book.get_ledger()
    
    gas_market = Market()
    gas_market.add_seller(supplier)
    #gas_market.add_buyer(buyer1)
    #gas_market.add_buyer(buyer2)
    for buy in buyer_dict.values():
        gas_market.add_buyer(buy)
    gas_market.set_book()
    asks = gas_market.get_asks()
    #print(asks)
    # time init stop
    stopit_init = time.time() - startit_init
    print('%s : init' % stopit_init)
    
    #start clearing
    startit_clearing = time.time()    
    clearing = gas_market.get_clearing_price()
    gas_market.annotate_ledger(clearing)
    new_ledger = gas_market.get_ledger()
    
    stopit_clearing = time.time() - startit_clearing
    print('%s : clearing' % stopit_clearing)
    # since this operation can take quite a while, print after every operation
    period_time = time.time() - startit_period
    print('%s : period time' % period_time)
    hist_book.append([god_info[period][0], clearing])


#######################################
jan
59.0201313495636 : init
5.312075138092041 : clearing
64.33220648765564 : period time
#######################################
feb
52.54562330245972 : init
4.4778969287872314 : clearing
57.02352023124695 : period time
#######################################
mar
45.38258957862854 : init
4.029738187789917 : clearing
49.41333317756653 : period time
#######################################
apr
38.02600288391113 : init
3.091214895248413 : clearing
41.117217779159546 : period time
#######################################
may
33.93216013908386 : init
3.0370731353759766 : clearing
36.96923327445984 : period time
#######################################
jun
28.66018795967102 : init
2.3361690044403076 : clearing
30.996356964111328 : period time
#######################################
jul
36.88095450401306 : init
2.3698058128356934 : clearing
39.2512571811676 : period time
#######################################
aug
30.48324990272522 : init
3.381986379623413 : clearing
33.86623764038086 : period time
#######################################
sep
34.01495289802551 : init
3.1713814735412598 : clearing
37.18633437156677 : period time
#######################################
okt
40.71514844894409 : init
3.4170444011688232 : clearing
44.13319993019104 : period time
#######################################
nov
44.783992767333984 : init
3.7539780139923096 : clearing
48.537970781326294 : period time
#######################################
dec
58.26960277557373 : init
5.110577821731567 : clearing
63.38114953041077 : period time

In [11]:
#pd.DataFrame.head(new_ledger)
df_hb = pd.DataFrame(hist_book)
df_hb = df_hb.set_index(0)
df_hb.index.name = 'month'
df_hb.rename(columns={1: 'price'}, inplace=True)

Operations Research Formulation

The market can also be formulated as a very simple linear program or linear complementarity problem. It is clearer and easier to implement this market clearing mechanism with agents. One merit of the agent-based approach is that we don't need linear or linearizeable supply and demand function.

The auctioneer is effectively following a very simple linear program subject to constraints on units sold. The auctioneer is, in the primal model, maximizing the consumer utility received by customers, with respect to the price being paid, subject to a fixed supply curve. On the dual side the auctioneer is minimizing the cost of production for the supplier, with respect to quantity sold, subject to a fixed demand curve. It is the presumed neutrality of the auctioneer which justifies the honest statement of supply and demand.

An alternative formulation is a linear complementarity problem. Here the presence of an optimal space of trades ensures that there is a Pareto optimal front of possible trades. The perfect opposition of interests in dividing the consumer and producer surplus means that this is a zero sum game. Furthermore the solution to this zero-sum game maximizes societal welfare and is therefore the Hicks optimal solution.

Next Steps

A possible addition of this model would be to have a weekly varying demand of customers, for instance caused by the use of natural gas as a heating agent. This would require the bids and asks to be time varying, and for the market to be run over successive time periods. A second addition would be to create transport costs, or enable intermediate goods to be produced. This would need a more elaborate market operator. Another possible addition would be to add a profit maximizing broker. This may require adding belief, fictitious play, or message passing.

The object-orientation of the models will probably need to be further rationalized. Right now the market requires very particular ordering of calls to function correctly.


In [12]:
# timeit

stopit = time.time()
dtstopit = datetime.datetime.now()

print('it took us %s seconds to get to this conclusion' % (stopit-startit))
print('in another notation (h:m:s) %s'% (dtstopit - dtstartit))
df_hb.plot()
plt.ylabel('€ / unit')


it took us 546.3412370681763 seconds to get to this conclusion
in another notation (h:m:s) 0:09:06.341237
Out[12]:
<matplotlib.text.Text at 0x203771eea20>

In [13]:
# print the run results
df_hb


Out[13]:
price
month
jan 7.584381
feb 7.282494
mar 7.188700
apr 6.463516
may 6.263530
jun 5.700304
jul 5.706242
aug 5.628913
sep 5.880470
okt 6.820972
nov 7.112594
dec 7.751644

In [14]:
# print the time of last run
print('last run of this notebook:')
time.strftime("%a, %d %b %Y %H:%M:%S", time.localtime())


last run of this notebook:
Out[14]:
'Wed, 14 Jun 2017 22:47:45'

In [ ]: